[PB] IndexQuery2.0
支持版本：3.50.0
简介
通过全局索引查询记录，支持SQL语法如附录。使用此接口需要提前在腾讯云控制台或本地Docker版的Web平台针对表添加全局索引字段。
POST http://{Tcaplus_REST_URL}
请求语法
Http请求
#国内idc&dev&其他自建环境：联系dba分配restproxy进程后由dba提供相应Tcaplus_REST_URL
#腾讯云控制台 RESTful Endpoint, ip:80, 端口默认80
http://172.17.0.22
#TcaplusDB本地docker版 RESTful Endpoint, ip:31001, 端口默认31001
http://9.135.8.93:31001
Http头
| 名称 | 是否必填 | 限制条件 | 说明 |
|---|---|---|---|
| x-tcaplus-target | 是 | 无 | Tcaplus.IndexQuery |
| x-tcaplus-version | 是 | 无 | Tcaplus3.50.0 |
| x-tcaplus-app-id | 是 | 无 | 对应业务id编号(aka,集群接入id) |
| x-tcaplus-zone-id | 是 | 无 | 对应zone编号(aka,表格组id) |
| x-tcaplus-protocol-version | 是 | 无 | 对应protocol版本号,默认2.0 |
| x-tcaplus-table-name | 是 | 无 | 对应表名 |
| x-tcaplus-pwd-md5 | 是 | 无 | 业务密码(aka,集群访问密码)，传入计算后的md5值 |
| x-tcaplus-idl-type | 是 | 无 | protobuf |
| x-tcaplus-result-flag | 否 | 无 | 0：操作成功后不返回数据1：操作成功后返回和请求一致的数据2：操作成功后返回本次update操作后的数据3：操作成功后返回tcapsvr端操作前的数据 |
| x-tcaplus-data-version-check | 否 | 1：检测记录版本号,只有当该版本号与服务器端的版本号相同时，该版本号才会自增2：不检测记录版本号，强制把客户端的记录版本号写入到服务器中3：不检测记录版本号，将服务器端的版本号自增 | |
| x-tcaplus-data-version | 否 | 具体的version值 |
示例：
x-tcaplus-target:Tcaplus.IndexQuery
x-tcaplus-app-id:3
x-tcaplus-zone-id:1
x-tcaplus-protocol-version:2.0
x-tcaplus-table-name:game_players
x-tcaplus-pwd-md5:4e81984efccfb4982333aeb1ff7968d5
x-tcaplus-result-flag:2
x-tcaplus-version:Tcaplus3.50.0
x-tcaplus-data-version-check: 3
x-tcaplus-idl-type:protobuf
Data
使用json格式表示记录相关信息。参数信息：
- Query: 必须，指定查询的SQL语句，详情参见分布式索引（全局索引）文档。
示例：以game_server_id索引字段作为 查询条件
#示例1，
{
"Query": "select player_id, player_name,player_email, game_server_id, pay.amount from game_players where game_server_id>0 limit 1 offset 0"
}
完整请求示例
curl -i -XPOST -H 'x-tcaplus-target: Tcaplus.IndexQuery' -H 'x-tcaplus-app-id: 70' -H 'x-tcaplus-zone-id: 1' -H 'x-tcaplus-protocol-version: 2.0' -H 'x-tcaplus-table-name: game_players' -H 'x-tcaplus-pwd-md5: 0972ad76decf4d11a69e2e0d9af335da' -H 'x-tcaplus-result-flag: 2' -H 'x-tcaplus-version: Tcaplus3.50.0' -H 'x-tcaplus-data-version-check: 1' -H 'x-tcaplus-idl-type: protobuf' http://172.17.32.17 -d '{
"Query": "select player_id, player_name,player_email, game_server_id, pay.amount from game_players where game_server_id>0 limit 1 offset 0"
}'
返回语法
返回参数说明
| 参数名 | 说明 |
|---|---|
| ErrorCode | 返回码 |
| ErrorMsg | 返回信息 |
| MultiRecords | 返回的记录集合 |
| Record | 返回的记录数据，根据SQL中查询的字段返回 |
| TotalNum | 返回匹配的记录条数 |
返回示例
成功返回示例
{
"ErrorCode": 0,
"ErrorMsg": "Succeed",
"MultiRecords": [{
"RecordVersion": 1,
"Record": {
"game_server_id": 55,
"pay": {
"amount": 55
},
"player_email": "55",
"player_id": 5,
"player_name": "5"
}
}],
"TotalNum": 1
}
失败返回示例
{"ErrorCode":-13841,"ErrorMsg":"proxy_err_query_index_field_not_exist"}
错误码
参考 常见错误码